Reorganise and improve the installation docs #1573
Conversation
stefanprodan
force-pushed
the
install-v2
branch
14 times, most recently
from
9b55796
to
bb220b0
Compare
|
Outline of the rewritten GitHub bootstrap documentation looks pretty good to me, and should be sufficient to proceed with the other ones. I will do more in-depth proof reading when I have the proper time, as I have some thoughts but nothing that would require rigorous changes. |
stefanprodan
force-pushed
the
install-v2
branch
4 times, most recently
from
9e1d077
to
099a4c2
Compare
stefanprodan
changed the title
stefanprodan
force-pushed
the
install-v2
branch
2 times, most recently
from
5aacf17
to
a7b6319
Compare
stefanprodan
added
area/docs
Made updates in accordance to the GitHub, GitLab, etc docs as done in #1573 Signed-off-by: mehak151 <66996176+mehak151@users.noreply.github.com>
stefanprodan
force-pushed
the
install-v2
branch
from
104b0b7
to
d4e8270
Compare
Co-authored-by: Kingdon Barrett <kingdon@weave.works> Co-authored-by: mehak151 <66996176+mehak151@users.noreply.github.com> Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
stefanprodan
force-pushed
the
install-v2
branch
from
d4e8270
to
89cbd4b
Compare
|
I see some bad link regressions after the rebase: https://gist.github.com/kingdonb/b725109eb070dc33ac9337e8609d7446 They are all in the blog, I think you probably don't care about that too much. But we can still fix them. (Feedback welcome about the log output format, I have added a logger and can now set up custom log formatting for the report... I'm making the enhancements needed so we can put this into our CI pipeline) I excluded everything that isn't high-level status (INFO) and tried to use a couple of the other log statuses, any messages that aren't needed for the work go to DEBUG level now. I'll push a commit updating these, the other errors are all about "components" which are just depending on the changes in other repos linked above. Those other components issues should all be resolved once those above PRs get merged. |
|
Note this is gone from the updated docs: https://fluxcd.io/flux/cheatsheets/bootstrap/#enable-notifications-for-third-party-controllers We can fix the blog so it points at the v2.0 docs once this transition to versioned docs is over, (right now it's not clear to me where that link is going to wind up.) |
|
Uh please push a commit to this branch for the blog, not sure how I messed up the rebase. |
Can you please add this to tf-controller docs. |
Co-authored-by: Kingdon Barrett <kingdon@weave.works> Co-authored-by: mehak151 <66996176+mehak151@users.noreply.github.com> Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
stefanprodan
force-pushed
the
install-v2
branch
from
6d6b37b
to
8ac5345
Compare
The bootstrap cheatsheet doc is going away Signed-off-by: Kingdon Barrett <kingdon@weave.works>
|
That doc link is updated in the branch now, I pulled it in so we could check over this PR with the v1-beta check in #1630 one last time. |
This PR implements: * https://github.com/kingdonb/link-checker-gpt/tree/v1-beta#integration-as-a-ci-check I'm testing the new Dockerized version of the link-checker-gpt, that helped us fix all the broken links in #1573 It should be possible to merge this if we are happy with it, independent of the release for Flux v2.1 (it can certainly wait until after 👍) I'm going to push a broken link as a test. The currently only major issue that I'm aware of is that, if Netlify build takes longer than a few seconds (60s or so) then subsequent checks may not be running against the latest version. I would like to fix this before releasing it by adding a reader that checks the GitHub Actions Checks statuses. It is already checking to see if the preview site is really online, and waiting up to 60s for that condition to become ready (with a sizeable delay front-loaded as we have to gather a baseline report from fluxcd.io before we can begin to check a PR, there has been some thought put into making a good workflow in a way such that we don't want to 86 it right away... minor annoyances should all be squashed prior to their annoying anyone, 🤞 bet) Signed-off-by: Kingdon Barrett <kingdon@weave.works>
This PR implements: * https://github.com/kingdonb/link-checker-gpt/tree/v1-beta#integration-as-a-ci-check I'm testing the new Dockerized version of the link-checker-gpt, that helped us fix all the broken links in #1573 It should be possible to merge this if we are happy with it, independent of the release for Flux v2.1 (it can certainly wait until after 👍) I'm going to push a broken link as a test. There has been some thought put into making a good workflow in a way such that we don't want to 86 it right away... minor annoyances should all be squashed prior to their annoying anyone * add the workflow to .github/workflows * fix the bug (upstream) * provide GH_TOKEN to link checker * (fix github token) Signed-off-by: Kingdon Barrett <kingdon@weave.works>
|
The link checker report still reads some errors, but we can deal with it after it merges if any are still present: I added b73421b in the install-v2 branch, that fixes one more. |
This PR implements: * https://github.com/kingdonb/link-checker-gpt/tree/v1-beta#integration-as-a-ci-check I'm testing the new Dockerized version of the link-checker-gpt, that helped us fix all the broken links in #1573 It should be possible to merge this if we are happy with it, independent of the release for Flux v2.1 (it can certainly wait until after 👍) I'm going to push a broken link as a test. There has been some thought put into making a good workflow in a way such that we don't want to 86 it right away... minor annoyances should all be squashed prior to their annoying anyone * add the workflow to .github/workflows * fix the bug (upstream) * provide GH_TOKEN to link checker * (fix github token) Signed-off-by: Kingdon Barrett <kingdon@weave.works>
The re-organization that happened as part of #1573 removed this page. PR #1573 added a redirect for /flux/cheatsheets/bootstrap but in this case it's better to specifically link directly to the customization guide instead of the general configuration page. closes #1658 Signed-off-by: Max Jonas Werner <mail@makk.es>
This PR reorganises and improves the installation documentation as specified in #1560.
Co-authored-by: @mehak151 and @kingdonb
Preview
https://deploy-preview-1573--fluxcd.netlify.app/flux/installation/
Completion status
Refs
Closes: #1560
Supersedes: #1568